Inscoper::StatusParam¶

StatusParam class pairs a sub-device with a value. More...

#include <StatusParam.h>

Inherited by Inscoper::ParentStatusParam

Public Functions¶

	Name
	StatusParam(const StatusParam & other) Copy constructor.
	StatusParam(StatusParam && other) Move constructor.
StatusParam &	operator=(const StatusParam & other) Copy assignment operator.
StatusParam &	operator=(StatusParam && other) Move assignment operator.
	StatusParam(const Inscoper::SubDeviceId & subDeviceId) Constructor from sub-device ID.
	StatusParam(const Inscoper::SubDeviceId & subDeviceId, const std::string & value) Constructor from sub-device ID and string value.
	StatusParam(const Inscoper::SubDeviceId & subDeviceId, unsigned char value) Constructor from sub-device ID and unsigned char value.
	StatusParam(const Inscoper::SubDeviceId & subDeviceId, char value) Constructor from sub-device ID and char value.
	StatusParam(const Inscoper::SubDeviceId & subDeviceId, unsigned short value) Constructor from sub-device ID and unsigned short value.
	StatusParam(const Inscoper::SubDeviceId & subDeviceId, short value) Constructor from sub-device ID and short value.
	StatusParam(const Inscoper::SubDeviceId & subDeviceId, unsigned int value) Constructor from sub-device ID and unsigned int value.
	StatusParam(const Inscoper::SubDeviceId & subDeviceId, int value) Constructor from sub-device ID and int value.
	StatusParam(const Inscoper::SubDeviceId & subDeviceId, unsigned long long int value) Constructor from sub-device ID and unsigned long long value.
	StatusParam(const Inscoper::SubDeviceId & subDeviceId, long long int value) Constructor from sub-device ID and long long value.
	StatusParam(const Inscoper::SubDeviceId & subDeviceId, float value) Constructor from sub-device ID and float value.
	StatusParam(const Inscoper::SubDeviceId & subDeviceId, double value) Constructor from sub-device ID and double value.
	StatusParam(const Inscoper::SubDeviceId & subDeviceId, bool value) Constructor from sub-device ID and boolean value.
	StatusParam(const Inscoper::SubDeviceId & subDeviceId, const char * value) Constructor from sub-device ID and C-string value.
	~StatusParam() Destructor.
const Inscoper::SubDeviceId	getSubDeviceId() const Get sub-device ID.
void	setSubDeviceId(const Inscoper::SubDeviceId & subDeviceId) Set sub-device ID.
bool	hasValue() Check if the status parameter has a value.
std::string	getStringValue() Get value as string.
unsigned char	getUnsignedCharValue() Get value as unsigned char.
char	getCharValue() Get value as char.
unsigned short	getUnsignedShortValue() Get value as unsigned short.
short	getShortValue() Get value as short.
unsigned int	getUnsignedIntValue() Get value as unsigned int.
int	getIntValue() Get value as int.
unsigned long long int	getUnsignedLongValue() Get value as unsigned long long.
long long int	getLongValue() Get value as long long.
float	getFloatValue() Get value as float.
double	getDoubleValue() Get value as double.
void	setValue(const std::string & value) Set value from string.
void	setValue(unsigned char value) Set value from unsigned char.
void	setValue(char value) Set value from char.
void	setValue(unsigned short value) Set value from unsigned short.
void	setValue(short value) Set value from short.
void	setValue(unsigned int value) Set value from unsigned int.
void	setValue(int value) Set value from int.
void	setValue(unsigned long long int value) Set value from unsigned long long.
void	setValue(long long int value) Set value from long long.
void	setValue(float value) Set value from float.
void	setValue(double value) Set value from double.
void	setValue(bool value) Set value from bool.
void	setValue(const char * value) Set value from C-string.
void	addValue(unsigned short tag, const std::string & value) Add a string value for a specific parameter index.
void	addValue(unsigned short tag, unsigned char value) Add a tagged unsigned char value for a specific parameter index.
void	addValue(unsigned short tag, char value) Add a tagged char value for a specific parameter index.
void	addValue(unsigned short tag, unsigned short value) Add a tagged unsigned short value for a specific parameter index.
void	addValue(unsigned short tag, short value) Add a tagged short value for a specific parameter index.
void	addValue(unsigned short tag, unsigned int value) Add a tagged unsigned int value for a specific parameter index.
void	addValue(unsigned short tag, int value) Add a tagged int value for a specific parameter index.
void	addValue(unsigned short tag, unsigned long long int value) Add a tagged unsigned long long value for a specific parameter index.
void	addValue(unsigned short tag, long long int value) Add a tagged long long value for a specific parameter index.
void	addValue(unsigned short tag, float value) Add a tagged float value for a specific parameter index.
void	addValue(unsigned short tag, double value) Add a tagged double value for a specific parameter index.
void	addValue(unsigned short tag, bool value) Add a tagged boolean value for a specific parameter index.
void	addValue(unsigned short tag, const char * value) Add a tagged C-string value for a specific parameter index.
void	addValue(unsigned short index, unsigned short tag, const std::string & value) Add a string value associated with a specific parameter index and value index.
void	addValue(unsigned short index, unsigned short tag, unsigned char value) Add an unsigned char value associated with a specific parameter index and value index.
void	addValue(unsigned short index, unsigned short tag, char value) Add a char value associated with a specific parameter index and value index.
void	addValue(unsigned short index, unsigned short tag, unsigned short value) Add an unsigned short value associated with a specific parameter index and value index.
void	addValue(unsigned short index, unsigned short tag, short value) Add a short value associated with a specific parameter index and value index.
void	addValue(unsigned short index, unsigned short tag, unsigned int value) Add an unsigned int value associated with a specific parameter index and value index.
void	addValue(unsigned short index, unsigned short tag, int value) Add an int value associated with a specific parameter index and value index.
void	addValue(unsigned short index, unsigned short tag, unsigned long long int value) Add an unsigned long long value associated with a specific parameter index and value index.
void	addValue(unsigned short index, unsigned short tag, long long int value) Add a long long value associated with a specific parameter index and value index.
void	addValue(unsigned short index, unsigned short tag, float value) Add a float value associated with a specific parameter index and value index.
void	addValue(unsigned short index, unsigned short tag, double value) Add a double value associated with a specific parameter index and value index.
void	addValue(unsigned short index, unsigned short tag, bool value) Add a bool value associated with a specific parameter index and value index.
void	addValue(unsigned short index, unsigned short tag, const char * value) Add a C-string value associated with a specific parameter index and value index.
virtual std::string	getType() Get type as string (deprecated).
virtual std::string	print() Get string representation.
Inscoper::EParamType	getValueType() Get value type.
virtual std::shared_ptr< StatusParam >	clone() Clone object.
virtual bool	equals(const std::shared_ptr< StatusParam > & other) Check equality.
virtual std::shared_ptr< Core::InternalStatusParam >	getInternal() Get internal object.

Protected Attributes¶

	Name
std::shared_ptr< Core::InternalStatusParam >	_internal

Detailed Description¶

class Inscoper::StatusParam;

StatusParam class pairs a sub-device with a value.

This class represents a status parameter, associating a specific sub-device with a value.

Public Functions Documentation¶

function StatusParam¶

StatusParam(
    const StatusParam & other
)

Copy constructor.

Parameters:

other : The StatusParam to copy

Creates a new StatusParam as a copy of an existing one.

function StatusParam¶

StatusParam(
    StatusParam && other
)

Move constructor.

Parameters:

other : The StatusParam to move

Creates a new StatusParam by moving resources from an existing one.

function operator=¶

StatusParam & operator=(
    const StatusParam & other
)

Copy assignment operator.

Parameters:

other : The StatusParam to copy

Return: A reference to this StatusParam

Assigns the values of another StatusParam to this one.

function operator=¶

StatusParam & operator=(
    StatusParam && other
)

Move assignment operator.

Parameters:

other : The StatusParam to move

Return: A reference to this StatusParam

Moves resources from another StatusParam to this one.

function StatusParam¶

StatusParam(
    const Inscoper::SubDeviceId & subDeviceId
)

Constructor from sub-device ID.

Parameters:

subDeviceId : The sub-device ID

Initializes a new StatusParam for a specific sub-device without a value.

function StatusParam¶

StatusParam(
    const Inscoper::SubDeviceId & subDeviceId,
    const std::string & value
)

Constructor from sub-device ID and string value.

Parameters:

subDeviceId : The sub-device ID
value : The associated string value

function StatusParam¶

StatusParam(
    const Inscoper::SubDeviceId & subDeviceId,
    unsigned char value
)

Constructor from sub-device ID and unsigned char value.

Parameters:

subDeviceId : The sub-device ID
value : The associated unsigned char value

function StatusParam¶

StatusParam(
    const Inscoper::SubDeviceId & subDeviceId,
    char value
)

Constructor from sub-device ID and char value.

Parameters:

subDeviceId : The sub-device ID
value : The associated char value

function StatusParam¶

StatusParam(
    const Inscoper::SubDeviceId & subDeviceId,
    unsigned short value
)

Constructor from sub-device ID and unsigned short value.

Parameters:

subDeviceId : The sub-device ID
value : The associated unsigned short value

function StatusParam¶

StatusParam(
    const Inscoper::SubDeviceId & subDeviceId,
    short value
)

Constructor from sub-device ID and short value.

Parameters:

subDeviceId : The sub-device ID
value : The associated short value

function StatusParam¶

StatusParam(
    const Inscoper::SubDeviceId & subDeviceId,
    unsigned int value
)

Constructor from sub-device ID and unsigned int value.

Parameters:

subDeviceId : The sub-device ID
value : The associated unsigned int value

function StatusParam¶

StatusParam(
    const Inscoper::SubDeviceId & subDeviceId,
    int value
)

Constructor from sub-device ID and int value.

Parameters:

subDeviceId : The sub-device ID
value : The associated int value

function StatusParam¶

StatusParam(
    const Inscoper::SubDeviceId & subDeviceId,
    unsigned long long int value
)

Constructor from sub-device ID and unsigned long long value.

Parameters:

subDeviceId : The sub-device ID
value : The associated unsigned long long value

function StatusParam¶

StatusParam(
    const Inscoper::SubDeviceId & subDeviceId,
    long long int value
)

Constructor from sub-device ID and long long value.

Parameters:

subDeviceId : The sub-device ID
value : The associated long long value

function StatusParam¶

StatusParam(
    const Inscoper::SubDeviceId & subDeviceId,
    float value
)

Constructor from sub-device ID and float value.

Parameters:

subDeviceId : The sub-device ID
value : The associated float value

function StatusParam¶

StatusParam(
    const Inscoper::SubDeviceId & subDeviceId,
    double value
)

Constructor from sub-device ID and double value.

Parameters:

subDeviceId : The sub-device ID
value : The associated double value

function StatusParam¶

StatusParam(
    const Inscoper::SubDeviceId & subDeviceId,
    bool value
)

Constructor from sub-device ID and boolean value.

Parameters:

subDeviceId : The sub-device ID
value : The associated boolean value

function StatusParam¶

StatusParam(
    const Inscoper::SubDeviceId & subDeviceId,
    const char * value
)

Constructor from sub-device ID and C-string value.

Parameters:

subDeviceId : The sub-device ID
value : The associated C-string value

function ~StatusParam¶

~StatusParam()

Destructor.

function getSubDeviceId¶

const Inscoper::SubDeviceId getSubDeviceId() const

Get sub-device ID.

Return: The sub-device ID

Retrieves the ID of the sub-device associated with this parameter.

function setSubDeviceId¶

void setSubDeviceId(
    const Inscoper::SubDeviceId & subDeviceId
)

Set sub-device ID.

Parameters:

subDeviceId : The sub-device ID

Sets the ID of the sub-device associated with this parameter.

function hasValue¶

bool hasValue()

Check if the status parameter has a value.

Return: True if the status parameter has a value, false otherwise

Indicates whether a value has been assigned to this status parameter.

function getStringValue¶

std::string getStringValue()

Get value as string.

Exceptions:

InscoperException If error conversion or retrieval fails

Return: The string value

Retrieves the status parameter value as a string.

function getUnsignedCharValue¶

unsigned char getUnsignedCharValue()

Get value as unsigned char.

Exceptions:

InscoperException If error conversion or retrieval fails

Return: The unsigned char value

Retrieves the status parameter value as an unsigned char.

function getCharValue¶

char getCharValue()

Get value as char.

Exceptions:

InscoperException If error conversion or retrieval fails

Return: The char value

Retrieves the status parameter value as a char.

function getUnsignedShortValue¶

unsigned short getUnsignedShortValue()

Get value as unsigned short.

Exceptions:

InscoperException If error conversion or retrieval fails

Return: The unsigned short value

Retrieves the status parameter value as an unsigned short.

function getShortValue¶

short getShortValue()

Get value as short.

Exceptions:

InscoperException If error conversion or retrieval fails

Return: The short value

Retrieves the status parameter value as a short.

function getUnsignedIntValue¶

unsigned int getUnsignedIntValue()

Get value as unsigned int.

Exceptions:

InscoperException If error conversion or retrieval fails

Return: The unsigned int value

Retrieves the status parameter value as an unsigned int.

function getIntValue¶

int getIntValue()

Get value as int.

Exceptions:

InscoperException If error conversion or retrieval fails

Return: The int value

Retrieves the status parameter value as an int.

function getUnsignedLongValue¶

unsigned long long int getUnsignedLongValue()

Get value as unsigned long long.

Exceptions:

InscoperException If error conversion or retrieval fails

Return: The unsigned long long value

Retrieves the status parameter value as an unsigned long long.

function getLongValue¶

long long int getLongValue()

Get value as long long.

Exceptions:

InscoperException If error conversion or retrieval fails

Return: The long long value

Retrieves the status parameter value as a long long.

function getFloatValue¶

float getFloatValue()

Get value as float.

Exceptions:

InscoperException If error conversion or retrieval fails

Return: The float value

Retrieves the status parameter value as a float.

function getDoubleValue¶

double getDoubleValue()

Get value as double.

Exceptions:

InscoperException If error conversion or retrieval fails

Return: The double value

Retrieves the status parameter value as a double.

function setValue¶

void setValue(
    const std::string & value
)

Set value from string.

Parameters:

value : The string value

Assigns a string value to the status parameter.

function setValue¶

void setValue(
    unsigned char value
)

Set value from unsigned char.

Parameters:

value : The unsigned char value

Assigns an unsigned char value to the status parameter.

function setValue¶

void setValue(
    char value
)

Set value from char.

Parameters:

value : The char value

Assigns a char value to the status parameter.

function setValue¶

void setValue(
    unsigned short value
)

Set value from unsigned short.

Parameters:

value : The unsigned short value

Assigns an unsigned short value to the status parameter.

function setValue¶

void setValue(
    short value
)

Set value from short.

Parameters:

value : The short value

Assigns a short value to the status parameter.

function setValue¶

void setValue(
    unsigned int value
)

Set value from unsigned int.

Parameters:

value : The unsigned int value

Assigns an unsigned int value to the status parameter.

function setValue¶

void setValue(
    int value
)

Set value from int.

Parameters:

value : The int value

Assigns an int value to the status parameter.

function setValue¶

void setValue(
    unsigned long long int value
)

Set value from unsigned long long.

Parameters:

value : The unsigned long long value

Assigns an unsigned long long value to the status parameter.

function setValue¶

void setValue(
    long long int value
)

Set value from long long.

Parameters:

value : The long long value

Assigns a long long value to the status parameter.

function setValue¶

void setValue(
    float value
)

Set value from float.

Parameters:

value : The float value

Assigns a float value to the status parameter.

function setValue¶

void setValue(
    double value
)

Set value from double.

Parameters:

value : The double value

Assigns a double value to the status parameter.

function setValue¶

void setValue(
    bool value
)

Set value from bool.

Parameters:

value : The boolean value

Assigns a boolean value to the status parameter.

function setValue¶

void setValue(
    const char * value
)

Set value from C-string.

Parameters:

value : The C-string value

Assigns a C-string value to the status parameter.

function addValue¶

void addValue(
    unsigned short tag,
    const std::string & value
)

Add a string value for a specific parameter index.

Parameters:

tag : The parameter index
value : The string value

Used for functions with multiple parameters. Adds a string value for a specific parameter index.

function addValue¶

void addValue(
    unsigned short tag,
    unsigned char value
)

Add a tagged unsigned char value for a specific parameter index.

Parameters:

tag : The parameter index
value : The unsigned char value

Used for functions with multiple parameters. Adds an unsigned char value for a specific parameter index.

function addValue¶

void addValue(
    unsigned short tag,
    char value
)

Add a tagged char value for a specific parameter index.

Parameters:

tag : The parameter index
value : The char value

Used for functions with multiple parameters. Adds a char value for a specific parameter index.

function addValue¶

void addValue(
    unsigned short tag,
    unsigned short value
)

Add a tagged unsigned short value for a specific parameter index.

Parameters:

tag : The parameter index
value : The unsigned short value

Used for functions with multiple parameters. Adds an unsigned short value for a specific parameter index.

function addValue¶

void addValue(
    unsigned short tag,
    short value
)

Add a tagged short value for a specific parameter index.

Parameters:

tag : The parameter index
value : The short value

Used for functions with multiple parameters. Adds a short value for a specific parameter index.

function addValue¶

void addValue(
    unsigned short tag,
    unsigned int value
)

Add a tagged unsigned int value for a specific parameter index.

Parameters:

tag : The parameter index
value : The unsigned int value

Used for functions with multiple parameters. Adds an unsigned int value for a specific parameter index.

function addValue¶

void addValue(
    unsigned short tag,
    int value
)

Add a tagged int value for a specific parameter index.

Parameters:

tag : The parameter index
value : The int value

Used for functions with multiple parameters. Adds an int value for a specific parameter index.

function addValue¶

void addValue(
    unsigned short tag,
    unsigned long long int value
)

Add a tagged unsigned long long value for a specific parameter index.

Parameters:

tag : The parameter index
value : The unsigned long long value

Used for functions with multiple parameters. Adds an unsigned long long value for a specific parameter index.

function addValue¶

void addValue(
    unsigned short tag,
    long long int value
)

Add a tagged long long value for a specific parameter index.

Parameters:

tag : The parameter index
value : The long long value

Used for functions with multiple parameters. Adds a long long value for a specific parameter index.

function addValue¶

void addValue(
    unsigned short tag,
    float value
)

Add a tagged float value for a specific parameter index.

Parameters:

tag : The parameter index
value : The float value

Used for functions with multiple parameters. Adds a float value for a specific parameter index.

function addValue¶

void addValue(
    unsigned short tag,
    double value
)

Add a tagged double value for a specific parameter index.

Parameters:

tag : The parameter index
value : The double value

Used for functions with multiple parameters. Adds a double value for a specific parameter index.

function addValue¶

void addValue(
    unsigned short tag,
    bool value
)

Add a tagged boolean value for a specific parameter index.

Parameters:

tag : The parameter index
value : The boolean value

Used for functions with multiple parameters. Adds a bool value for a specific parameter index.

function addValue¶

void addValue(
    unsigned short tag,
    const char * value
)

Add a tagged C-string value for a specific parameter index.

Parameters:

tag : The parameter index
value : The C-string value

Used for functions with multiple parameters. Adds a C-string value for a specific parameter index.

function addValue¶

void addValue(
    unsigned short index,
    unsigned short tag,
    const std::string & value
)

Add a string value associated with a specific parameter index and value index.

Parameters:

index : The value index
tag : The parameter index
value : The string value

Used for functions with multiple parameters to be called several times with different values. Adds a string value associated with a specific parameter index and value index.

function addValue¶

void addValue(
    unsigned short index,
    unsigned short tag,
    unsigned char value
)

Add an unsigned char value associated with a specific parameter index and value index.

Parameters:

index : The value index
tag : The parameter index
value : The unsigned char value

Used for functions with multiple parameters to be called several times with different values. Adds an unsigned char value associated with a specific parameter index and value index.

function addValue¶

void addValue(
    unsigned short index,
    unsigned short tag,
    char value
)

Add a char value associated with a specific parameter index and value index.

Parameters:

index : The value index
tag : The parameter index
value : The char value

Used for functions with multiple parameters to be called several times with different values. Adds a char value associated with a specific parameter index and value index.

function addValue¶

void addValue(
    unsigned short index,
    unsigned short tag,
    unsigned short value
)

Add an unsigned short value associated with a specific parameter index and value index.

Parameters:

index : The value index
tag : The parameter index
value : The unsigned short value

Used for functions with multiple parameters to be called several times with different values. Adds an unsigned short value associated with a specific parameter index and value index.

function addValue¶

void addValue(
    unsigned short index,
    unsigned short tag,
    short value
)

Add a short value associated with a specific parameter index and value index.

Parameters:

index : The value index
tag : The parameter index
value : The short value

Used for functions with multiple parameters to be called several times with different values. Adds a short value associated with a specific parameter index and value index.

function addValue¶

void addValue(
    unsigned short index,
    unsigned short tag,
    unsigned int value
)

Add an unsigned int value associated with a specific parameter index and value index.

Parameters:

index : The value index
tag : The parameter index
value : The unsigned int value

Used for functions with multiple parameters to be called several times with different values. Adds an unsigned int value associated with a specific parameter index and value index.

function addValue¶

void addValue(
    unsigned short index,
    unsigned short tag,
    int value
)

Add an int value associated with a specific parameter index and value index.

Parameters:

index : The value index
tag : The parameter index
value : The int value

Used for functions with multiple parameters to be called several times with different values. Adds an int value associated with a specific parameter index and value index.

function addValue¶

void addValue(
    unsigned short index,
    unsigned short tag,
    unsigned long long int value
)

Add an unsigned long long value associated with a specific parameter index and value index.

Parameters:

index : The value index
tag : The parameter index
value : The unsigned long long value

Used for functions with multiple parameters to be called several times with different values. Adds an unsigned long long value associated with a specific parameter index and value index.

function addValue¶

void addValue(
    unsigned short index,
    unsigned short tag,
    long long int value
)

Add a long long value associated with a specific parameter index and value index.

Parameters:

index : The value index
tag : The parameter index
value : The long long value

Used for functions with multiple parameters to be called several times with different values. Adds a long long value associated with a specific parameter index and value index.

function addValue¶

void addValue(
    unsigned short index,
    unsigned short tag,
    float value
)

Add a float value associated with a specific parameter index and value index.

Parameters:

index : The value index
tag : The parameter index
value : The float value

Used for functions with multiple parameters to be called several times with different values. Adds a float value associated with a specific parameter index and value index.

function addValue¶

void addValue(
    unsigned short index,
    unsigned short tag,
    double value
)

Add a double value associated with a specific parameter index and value index.

Parameters:

index : The value index
tag : The parameter index
value : The double value

Used for functions with multiple parameters to be called several times with different values. Adds a double value associated with a specific parameter index and value index.

function addValue¶

void addValue(
    unsigned short index,
    unsigned short tag,
    bool value
)

Add a bool value associated with a specific parameter index and value index.

Parameters:

index : The value index
tag : The parameter index
value : The bool value

Used for functions with multiple parameters to be called several times with different values. Adds a bool value associated with a specific parameter index and value index.

function addValue¶

void addValue(
    unsigned short index,
    unsigned short tag,
    const char * value
)

Add a C-string value associated with a specific parameter index and value index.

Parameters:

index : The value index
tag : The parameter index
value : The C-string value

Used for functions with multiple parameters to be called several times with different values. Adds a C-string value associated with a specific parameter index and value index.

function getType¶

virtual std::string getType()

Get type as string (deprecated).

Return: The type string

function print¶

virtual std::string print()

Get string representation.

Return: The string representation

Retrieves a string representation of the status parameter.

function getValueType¶

Inscoper::EParamType getValueType()

Get value type.

Exceptions:

InscoperException If error occurs

Return: The parameter type

Retrieves the type of the value stored in this parameter.

function clone¶

virtual std::shared_ptr< StatusParam > clone()

Clone object.

Return: The copy

Reimplemented by: Inscoper::ChildStatusParam::clone, Inscoper::ModifiableStatusParam::clone

Creates a deep copy of this StatusParam.

function equals¶

virtual bool equals(
    const std::shared_ptr< StatusParam > & other
)

Check equality.

Parameters:

other : The status parameter to compare with

Return: True if meaningful content is equal, false otherwise

Reimplemented by: Inscoper::ChildStatusParam::equals, Inscoper::ModifiableStatusParam::equals

Compares this status parameter with another for equality. Test if all parameters values are equal.

function getInternal¶

virtual std::shared_ptr< Core::InternalStatusParam > getInternal()

Get internal object.

Return: Shared pointer to InternalStatusParam

Internal use only. Retrieves the internal implementation object.

Protected Attributes Documentation¶

variable _internal¶

std::shared_ptr< Core::InternalStatusParam > _internal;

Updated on 2026-04-02 at 10:55:36 +0200